Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-12-27 10:33:56 +08:00
Code Issues Projects Releases Packages Wiki Activity

copy(readme): update readme

Browse source
This commit is contained in:
Evan Morikawa 2015-10-02 13:04:31 -07:00
parent 6d14e36e71
commit 8cf124fef5
2 changed files with 43 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,40 @@
# Contributing to N1 Core
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
[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.
# Getting Started
Once you have a token:
git clone https://github.com/nylas/N1.git
cd N1
script/bootstrap
# Running N1 Core
./N1.sh --dev
Once the app boots, you'll be prompted to enter your early access token and
email credentials.
Our early access tokens 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
engine](https://github.com/nylas/sync-engine) repository.
# Testing N1 Core
./N1.sh --test
This will run the full suite of automated unit tests. We use [Jasmine 1.3](http://jasmine.github.io/1.3/introduction.html).
It runs all tests inside of the `/spec` folder and all tests inside of
`/internal_packages/**/spec`

21
README.md
View file

@ -12,24 +12,9 @@ to get early access. Star this repository to get even earlier access.
Everything in N1 is an extension. Building your own is easy. Everything in N1 is an extension. Building your own is easy.
1. Sign up [here](https://invite.nylas.com) to request an early access token 1. Sign up [here](https://invite.nylas.com) to request an early invitation code
1. Use your token to download N1 1. Use your token to download N1
1. Follow the getting started guides here to write your first extension in 5 minutes 1. Follow the getting started guides here to write your first extension in 5 minutes
# Contributing to N1 Core If you would like to run the N1 source and contribute, check out our [contributing
guide](https://github.com/nylas/N1/blob/master/CONTRIBUTING.md)
You currently need an early access token to get setup on N1. Sign up [here](https://invite.nylas.com) to request one.
Once you have a token:
```
git clone https://github.com/nylas/N1.git
cd N1
script/bootstrap
./N1.sh --dev
```
Our early access tokens 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 engine](https://github.com/nylas/sync-engine) repository.