copy(readme): update readmes

tomburtonwood · Oct 2, 2015 · 7c9e591 · 7c9e591
1 parent 2b2e47f
commit 7c9e591
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 46 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,9 +5,9 @@ Thank you for contributing!!
 N1 core is the foundation our community uses to build email extensions with the
 modern web.
 
-You currently need an early access token to get setup on N1. Sign up
+You currently need an early invitation code to get setup on N1. Sign up
 [here](https://invite.nylas.com) to request one. Drop us a line saying you'd
-like to contribute to N1 core and we'll get you setup immediately.
+like to contribute to N1 core and we'll get you set up immediately.
 
 # Getting Started
 
@@ -21,10 +21,10 @@ Once you have a token:
 
     ./N1.sh --dev
 
-Once the app boots, you'll be prompted to enter your early access token and
+Once the app boots, you'll be prompted to enter your early invitation code and
 email credentials.
 
-Our early access tokens are designed control access to our production mail sync
+Our early invitation codes are designed control access to our production mail sync
 engine while we roll out N1. However, the sync engine is [open
 source](https://github.com/nylas/sync-engine) and you can set it up yourself to
 begin using N1 immediately. Follow instructions on the [sync

diff --git a/apm/README.md b/apm/README.md
@@ -1,2 +1,3 @@
-This folder is where [apm](https://github.com/atom/apm) is installed to so that
-it is bundled with Atom.
+N1 uses [apm](https://github.com/atom/apm) to build packages instead of `npm`.
+This is because packages need to be compiled against Chrome's headers to work
+properly with Electron.
diff --git a/build/README.md b/build/README.md
@@ -1,10 +1,24 @@
-# Atom Build
+# N1 Building and Tasks
 
-This folder contains the grunt configuration and tasks to build Atom.
+This folder contains tasks to create production builds of N1
 
-It was moved from the root of the repository so that any native modules used
-would be compiled against node's v8 headers since anything stored in
-`node_modules` at the root of the repo is compiled against atom's v8 headers.
+Tasks should not be executed from this folder, but rather from `/scripts`. The
+`/scripts` folder has convenient methods that fix paths and do environment
+checks.
 
-New build dependencies should be added to the `package.json` file located in
-this folder.
+Note that most of the task definitions are stored in `/build/tasks`
+
+## Some useful tasks
+
+NOTE: Run all of these from the N1 root folder.
+
+**Linting:**
+
+    `script/grunt lint`
+
+**Building:**
+
+    `script/grunt build`
+
+The build folder has its own package.json and is isolated so we can use `npm`
+to compile against v8's headers instead of `apm`
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,6 @@
+# N1 Documentation
+
+For the full documentation (which includes these guides), go to:
+https://nylas.github.io/N1/docs/
+
+To see annotated package examples, go to: https://nylas.github.io/N1/examples/
diff --git a/dot-nylas/README.md b/dot-nylas/README.md
@@ -1,2 +1,4 @@
-# Config, Saved State, & defaults
-These are the default Nylas configs
+# Default Config
+
+These are the default Nylas configs. This folder on setup is copied to
+`~/.nylas` on unix machines.
diff --git a/examples/README.md b/examples/README.md
@@ -3,11 +3,8 @@
 Here you will find well-annotated samples to showcase how to build
 packages in N1.
 
+**See more on https://nylas.github.io/N1/examples/**
+
 ## Getting Started
 
-1. Each package is in its own folder. To try out a package, copy the folder
-   into `$HOME/.nylas/packages`, run `apm install`, and restart N1.
-2. The entry point of each package is the `activate` method of
-   `lib/main.cjsx`. Most packages do nothing but register themselves with
-   the `ComponentRegistry`
-3. Read the annotated source code of the package files.
+To get started, follow the getting started guides here: https://nylas.github.io/N1/docs/
diff --git a/script/cibuild-atom-linux b/script/cibuild-atom-linux
diff --git a/script/cibuild-atom-rpm b/script/cibuild-atom-rpm