Skip to content

Commit

Permalink
Merge pull request #4 from ThePawlow/pawlow-readme
Browse files Browse the repository at this point in the history
Updated the readme to make it easier to contribute
  • Loading branch information
deluvas1911 authored Jul 5, 2024
2 parents fb01484 + 4dbbf34 commit f89f11b
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
1. Use `npm i` to install all dependencies
2. Use `npm run start` to start the development server
# alt:V Docs
## How to contribute
These docs rely heavily on submodules to keep things organized.<br>
**NOTE** When forking, uncheck 'Copy the XYZ branch only' all the branches are mandatory.

Those repositories are needed:
- Fork this repository
- Fork https://github.com/altmp/altv-docs-articles
- Fork https://github.com/altmp/altv-types
## Building
1. Use `yarn` to install all dependencies
2. Use `yarn start` to start the development server
3. Navigate to `http://localhost:3000`

0 comments on commit f89f11b

Please sign in to comment.