Skip to content

Commit

Permalink
docs: 📝 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
surajgoraya committed Apr 18, 2023
1 parent 1166ac7 commit 1ecd580
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,8 @@ The output for the script should yield something like this if successfully run:

This project is built on Node.js, and requires Node.js and npm be installed on the computer. Contributions are welcome via pull request.

Compiling the project isn't required (you can run it like any other node project `npm run start`), but it can make it easier to run the script. This project uses pkg and ncc to achieve a single exec being created.
The command to build is `npm run build`, by default this only builds for macOS, however, the command can be modified to update the targets.

## Releases / Source
Source & Download Located here: [https://github.com/surajgoraya/CourseLink-Assignment-Name-Fixer](https://github.com/surajgoraya/CourseLink-Assignment-Name-Fixer)

0 comments on commit 1ecd580

Please sign in to comment.