Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
n1d3v authored Jun 18, 2024
1 parent 51a85f3 commit 354c127
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,30 @@ Changelog can be found in the root directory of this repo as `CHANGELOG.md`.
Contributing guide can be found in the root directory of this repo as `CONTRIBUTORS.md`.

# Installation
Download naticord-setup.exe if you are on Windows Vista+
Download naticord-setup.exe if you are on Windows Vista+ If you are on Vista, you will need to setup a proxy for communicating with the Discord API (this will soon not be needed).

### Updating
To update, you can just get the latest version and install it.

# Building Naticord
There are 2 ways to build Naticord, the easy route or the command-line route.

### The Easy Route
- Open Visual Studio 2022
- Launch the solution
- Install all the NuGet packages (it will do it automatically)
- Select Build at the top and click Build Solution.
- You can find your build at {naticordDir}\Naticord\bin\Debug\Naticord.exe or {naticordDir}\Naticord\bin\Release\Naticord.exe depending on what build type you have made.
### The command-line route
This requires VS 2022 installed.

- Open CMD
- Clone the naticord repository (this one)
- CD into the naticord directory
- Run `nuget restore Naticord\Naticord.sln` this will restore all the packages Naticord uses.
- Run `msbuild Naticord/Naticord.sln -t:rebuild -property:Configuration=Debug` this will generate a debug release of Naticord. If you want a release build switch out Debug for Release.
- You can find your build at {naticordDir}\Naticord\bin\Debug\Naticord.exe or {naticordDir}\Naticord\bin\Release\Naticord.exe depending on what build type you have made.

# What's working
- Logging in with an email and password (with MFA)
- Friends
Expand Down Expand Up @@ -52,6 +71,3 @@ To update, you can just get the latest version and install it.
- Edit reply and delete.
# Bugs
- Sometimes markdown glitches out.
# Projects that have helped out
- Insomnia: Godsend for fucking around with Discord APIs however I want. Overall great tool

0 comments on commit 354c127

Please sign in to comment.