Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kosmo authored Jun 16, 2024
1 parent 36ede91 commit f1ae2a7
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,33 +39,33 @@ Currently, there are no package installers available for Linux. Please see the i
If you'd like to build the program from source, follow these steps:

1. Open your system's terminal.
> - **macOS**: Simultaneously press the command key and space bar to open the `Spotlight` search field. Type "terminal", and then select `Terminal.app`.
> - **Windows**: Simultaneously press the Windows and 'R' keys to open the `Run` dialog. Type "cmd", and then press enter to open `Command Prompt`.
- **macOS**: Simultaneously press the command key and space bar to open the `Spotlight` search field. Type "terminal", and then select `Terminal.app`.
- **Windows**: Simultaneously press the Windows and 'R' keys to open the `Run` dialog. Type "cmd", and then press enter to open `Command Prompt`.

2. Navigate to the directory to which you would like to clone the `Shyft` repository. For simplicity, we'll assume you're cloning it to your home directory, which is usually where most systems set users' locations upon initialization of the login shell.

3. Clone the GitHub repository to your local machine. From `Terminal` (on macOS) or `cmd` (on Windows), run the following command.

> ```bash
> git clone https://github.com/kosmolebryce/shyft.git
>```
```bash
git clone https://github.com/kosmolebryce/shyft.git
```

3. After the repository has been cloned to your machine, navigate into the program's source code directory.
> ```bash
> cd shyft/src/shyft
> ```
```bash
cd shyft/src/shyft
```
4. At this point, you have a few options:
> - If you'd like to run the program without installing it, you can invoke it directly with your Python interpreter by entering the following command.
- If you'd like to run the program without installing it, you can invoke it directly with your Python interpreter by entering the following command.

> ```bash
> python shyft.py
> ```
```bash
python shyft.py
```

> > This will initialize the GUI, streaming debugging/logging statements as output to the terminal while the program is in use.
> This will initialize the GUI, streaming debugging/logging statements as output to the terminal while the program is in use.

> - If you'd like to build and install the program, there are lots of tools you can use. The most popular option for macOS is probably `py2app`, while the most popular options for Windows are probably `pyinstaller` and `cxfreeze`.
- If you'd like to build and install the program, there are lots of tools you can use. The most popular option for macOS is probably `py2app`, while the most popular options for Windows are probably `pyinstaller` and `cxfreeze`.
----
Expand Down

0 comments on commit f1ae2a7

Please sign in to comment.