Skip to content

Commit

Permalink
Note running .py for non-Windows systems
Browse files Browse the repository at this point in the history
  • Loading branch information
Mkranj committed Oct 7, 2023
1 parent 24a60f0 commit d0aaa27
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Find all citations mentioned in a document. Build and check your reference lists
***PapersCited*** is a program designed to help you with **writing and reviewing reference lists** in your scientific articles. It reads through a document of your choice and takes a note every time something is cited. At the end, it lists all of those citations in alphabetical order, omitting duplicate entries. You can also save them in an Excel or textual file.
Now you can easily go through your reference list and note if you cited something but didn't include it or, conversely, you wrote a reference that isn't cited anywhere in the article. It is also handy for writing a reference list from stratch. You no longer need to manually go over the whole article and note all the times you cite another source.

PapersCited covers **APA style** and **Vancouver style** citations excellently, but **Chicago style** and similar should work as well. The program was built with texts written in **English** and **Croatian** in mind. Some sources may be detected incorrectly in other languages.
PapersCited covers **APA style** and **Vancouver style** citations excellently, but **Chicago style** and similar should work as well. The program was built with texts written in **English** and **Croatian** in mind. Some sources may be detected incorrectly in other languages.

Tested on Windows 10 using .docx, .txt, .doc and .pdf files.

Expand All @@ -14,8 +14,8 @@ Found PapersCited useful? How about [**buying me a coffee**](https://www.buymeac
## Instructions:
- Download the latest version of **PapersCited.zip** from the *Releases* tab, to the right. *(Windows only)*
- Extract the archive in a folder of your choosing.
- The newly extracted folder contains data files, an example document, and a shorcut to the Paperscited program. **Run the PapersCited shortcut**.
- Click the button and select a file you want to analyse.
- The newly extracted folder contains an example document and the Paperscited executable. **Run PapersCited.exe**.
- Click the *Choose document* button and select a file you want to analyse.
- After inspecting the results, you can save them as .xlsx or .txt via appropriate buttons.

The program comes with a file called "*example.docx*" if you want to experiment with the program and preview what the output looks like.
Expand All @@ -36,7 +36,9 @@ The first column in the Excel file is empty so you can easily mark certain citat
- Copying text from a PDF to clipboard might yield unexpected characters, such as *´c* instead of *č*. This is a matter of the individual PDF file's encoding, however, it might lead to incorrect text scanning.

---
# Running the latest version of the Python script
# Running the latest version of the Python script
If you use an operating system other than Windows, or want the very latest changes on this Github, you'll need to install Python and the dependencies listed below.

## Dependencies:
This program was written using Python 3.9.12. It requires the following modules:
textract, xlsxwriter, regex, docx2python, tkinter
Expand All @@ -50,7 +52,7 @@ Keep the default values for all the settings **except** the checkbox asking to p

After installing Miniconda, open the start menu and search for Windows Powershell, then open it. Install the two modules required by the program, as described in **Dependencies**.

With all that done, the script should run when double-clicked. If it asks you which program to open it with, choose to *look for another app on this PC* and navigate to C:\Users\\*(your username)*\miniconda3 and select *python.exe*. Now you can just double-click on the script to run it.
With all that done, the *PapersCited.py* script should run when double-clicked. If it asks you which program to open it with, choose to *look for another app on this PC* and navigate to C:\Users\\*(your username)*\miniconda3 and select *python.exe*. Now you can just double-click on the script to run it.

# Lastly...
Any comments, bug reports and suggestions are welcome. Happy writing!

0 comments on commit d0aaa27

Please sign in to comment.