craftingguide/wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Adding support for a new Mod (markdown)

Browse Source
This commit is contained in:
Andrew Miner
2016-06-22 21:23:34 -07:00
parent e5e069a878
commit c2ae07091b
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Adding-support-for-a-new-Mod.md
+3 -3
View File
@@ -8,7 +8,9 @@ Create a fork of this repo in which to make your changes. If you're not sure ho
Crafting Guide comes with a number of different command-line scripts for processing data and testing. You'll need to get your machine set up with a few command-line tools to run them before you can begin. Crafting Guide comes with a number of different command-line scripts for processing data and testing. You'll need to get your machine set up with a few command-line tools to run them before you can begin.
Start by checking to see if you already have Node.js or Ruby installed on your machine by running the following commands: `which node` and `which ruby`. If you have them installed, you'll see where they're installed. If you don't have them, then there will be no output. If either is missing, download and install the most recent version of each from their websites: [Node.js](http://nodejs.org/download/) and [Ruby](https://ruby-lang.org). _**NOTE:** If you're using Windows (instead of MacOS or Linux), you'll want to perform all of these commands using the [Git for Windows](https://msysgit.github.io/) shell. You will also need to install [rsync](https://www.itefix.net/content/get-cwrsync) manually. Finally, windows users should leave out the word `sudo` from all commands._
Start by opening up a terminal window checking to see if you already have Node.js or Ruby installed on your machine by running the following commands: `which node` and `which ruby`. If you have them installed, you'll see where they're installed. If you don't have them, then there will be no output. If either is missing, download and install the most recent version of each from their websites: [Node.js](http://nodejs.org/download/) and [Ruby](https://ruby-lang.org).
Next, open a terminal and navigate to your new local repo. Create a file called `.env` with the following contents: Next, open a terminal and navigate to your new local repo. Create a file called `.env` with the following contents:
``` ```
@@ -30,8 +32,6 @@ npm install
grunt clean build start grunt clean build start
``` ```
_**NOTE:** If you're using Windows (instead of MacOS or Linux), you'll want to perform all of these commands using the [Git for Windows](https://msysgit.github.io/) shell. You will also need to install [rsync](https://www.itefix.net/content/get-cwrsync) manually. Finally, windows users should leave out the word `sudo` from all commands._
At this point, you'll have a local server running the CraftingGuide website at [http://localhost:8000] At this point, you'll have a local server running the CraftingGuide website at [http://localhost:8000]
(http://localhost:8000). As you work with your mod, you should verify your work on your local website. Your working directory will be in the CraftingGuideData repository: all the remaining commands deal with that repository. (http://localhost:8000). As you work with your mod, you should verify your work on your local website. Your working directory will be in the CraftingGuideData repository: all the remaining commands deal with that repository.