Commit Graph

63 Commits

Author SHA1 Message Date
Jesse Rosenberger
c92c8096fe Remove "Slow Start" from README.
Witty as it may be, the contribution guidelines are already listed here (and I've cleaned them up a bit too) and I'm not sure if this terminology is encouraging anyone to contribute their (precious) time.
2017-06-07 16:18:11 +03:00
Jesse Rosenberger
1a8bbe0fb4 Reposition "Developer Resources" higher in README.
Dev resources are more important than uninstallation instructions!
2017-06-07 15:56:49 +03:00
Jesse Rosenberger
32636e7c9b Added alt tag to Meteor logo. 2017-06-07 15:53:58 +03:00
Jesse Rosenberger
4a02872cad Add a Meteor Logo to the top of the README.
I think the Meteor README is deserving of some glitz and glamor.
2017-06-06 20:10:14 +03:00
Jesse Rosenberger
7e36188421 Development.md: How to Develop Meteor Itself (#8267)
* Blank slate Development.md

* Move "Running Tests" to Development.md

* Move "Running from a Git checkout" to Development.md

* Add information on running specific tests.

* Move the "run against local" disclaimer up to the first paragraph.

* Change header level to be the same as others.

* Remove superfluous section about running specific tests.

* Slight text adjustments

* Add information about continuous integration tests.

* Call the tool tests what they are: self-tests

* Add information about listing tests.

* "argument" => "option", since that's what it is.

* Move "more details" up higher in the text.

* Add test headings.

* How to: Run or exclude specific tests from the self-test tool.

* Add a link to Contributing.md from README.md

* Additional documentation = README.md files

* Add information about running your own CircleCI.

* Add section on code style.

* Add section on commit messages.

While the title is obvious, I guess I should add a commit description
here for the sake of fully explaining the importance of a good commit
message!  This commit, along with the ones before it should help make it
very clear how to contribute to Meteor!

* Update core contributor list.

In addition to adding myself, this adds Hugh Willson (@hwillson) and removes past contributors not currently active.

* Add information on finding work for those who want to contribute.

* Add link to documentation repo.

* Refer to the "Finding work" section from "Submitting pull requests".

* Refer to Roadmap.md from "Tracking project work".

* Hoist "Finding work" up to a more helpful location.

* Add note about files which are ignored by auto-linting.

* Clean up grammar on commit message "Fixes" notation bullet-point.

* Add link to guide.

* Suggest the use an alias for frequent contribution.

Per PR suggestions, add a suggestion to make an alias for more frequent use.  Also, due to difficulty of formatting aforementioned change, move unrelated Note (which didn't belong there) to a more prominent section called "Notes when running from a checkout"

* Add information about the "Dev Bundle".

This moves the dev bundle step out of the "Running from checkout", simplifying those steps, but breaks things down much more in its own, new, section.

* Changes as suggested.

Thanks to @klaussner and @hwillson for these suggestions!  I also changed some other trademark-y things. 😉

* Add a "more reading" section per discussion.

cc @hwillson

* Add a header to `Development.md` explaining its purpose.

Great suggestion, @benjamn.  Thanks.

* Fix header type of "Notes when running from a checkout".

This was inadvertently set as a "H1" (`#`) but should have been nested within the "Running from a Git checkout" section as an "H2" (`##`).
2017-03-09 13:30:32 +02:00
Jesse Rosenberger
246563e46c Remove explanation that you need git to compile dependencies
Obvious cat is obvious.  You couldn't have got to this step without `git`.
2016-10-13 14:35:11 +03:00
Jesse Rosenberger
6da919f434 Don't use $PS1 prompt to indicate cwd. Be more explicit. 2016-10-13 11:55:40 +03:00
Jesse Rosenberger
8576e6dcd6 Formatting and Finalization of "Slow Start for Developers"
This is a wrapup/cleanup on @lucfranken's PR to clarify and clean up the "Slow Start (for developers)" section of the README.

The next step will be to move this to a separate file where much more information can be added, but this incorporates most of the original suggestions and adds some additional formatting.
2016-10-12 18:26:15 +03:00
lucfranken
d059f95406 Fix typo in Your local Meteor checkout 2016-10-12 18:26:15 +03:00
lucfranken
fd9594d3a0 Remove reference to local docs which are not available anymore
As discussed in:
https://github.com/meteor/meteor/issues/7824#issuecomment-250106125

The docs are in a separate repository now:
https://github.com/meteor/docs/ and are not included anymore in a
standard checkout from meteor/meteor.
2016-10-12 18:26:15 +03:00
lucfranken
01b902bfb3 Fix missing /meteor part in command 2016-10-12 18:26:15 +03:00
lucfranken
8cd6db7191 Make clear how to run your app with a local checkout of Meteor
The README explained how to run Meteor from a checkout.

The example used is the Meteor docs app which is available in the
Meteor repository itself. However it did not mention how you can run
the local Meteor checkout from a local app.

That is the most basic use case, for example to reproduce a bug. That’s
why an example of that is added based on meteor create so we focus on
creating a clean reproduction. That way we can point to it when people
want to debug their own issue.
2016-10-12 18:26:06 +03:00
Ben Newman
52657f6c1f Add more explanation of submodules to README.md. 2016-09-09 10:51:14 -04:00
Tom Coleman
d695087c92 We'll need to clone submodules too now 2016-08-25 12:23:33 +10:00
Wexpo Lyu
e91b342360 Update README.md for Windows users. (#7610)
* Update README.md

* Update README.md
2016-08-10 19:10:30 -04:00
Birk Skyum
a850b91f25 Update README.md
Use the install command shown at https://www.meteor.com/install
2016-07-30 19:22:51 +02:00
Ben Newman
7c47e5ecd0 Add Travis CI status badge to README.md. 2016-05-16 17:44:26 -04:00
Wexpo Lyu
997952d9af Correct the format of CircleCI badge. 2016-05-14 07:45:29 +08:00
Tom Coleman
de65888e60 Added circle token 2016-05-10 15:08:04 -07:00
Zoltan Olah
aedee2df30 Update README.md 2016-04-07 09:28:40 -07:00
Zoltan Olah
61cd0be862 Adds guide to readme 2016-04-07 09:28:12 -07:00
Wexpo Lyu
0810cb574b Fixes #6686 2016-04-03 13:42:18 +08:00
Zoltan Olah
9fd26a8a7c Update README.md 2016-02-17 12:13:44 -08:00
Slava Kim
85da84079b Link the tutorial from README.md 2015-08-14 10:56:17 -07:00
Slava Kim
08c1761e0c mark code-blocks in readme as bash 2015-08-10 11:52:40 -07:00
Matt DeBergalis
13e98f5a4a switch to forums 2015-02-26 20:13:46 -08:00
Dan Dascalescu
fb5ef8555e Typo and broken link fix 2014-10-28 17:39:17 -07:00
Richard Guan
a272d3c6e9 Missing a period(.) in this one sentence
Entire document has sentences ending in periods except for this one
(including the ones ending in quotes).
2014-09-29 15:01:06 -07:00
Matt DeBergalis
53c3143285 jobs note 2014-06-24 09:29:52 -07:00
Nick Martin
0db5b9393a update readme to note build requirements. 2013-12-19 15:46:44 -08:00
David Glasser
b414cd15bb Fix README instructions about running docs app. 2013-10-07 15:12:44 -07:00
Nick Martin
841b0d3588 Fix contributing link in main README. 2013-04-01 19:10:31 -07:00
David Glasser
3b137562c6 Docs are only in the checkout. 2013-04-01 15:03:28 -07:00
David Glasser
441059692f Add uninstall instructions to README.md. (They are in launch-meteor as well.) 2013-04-01 10:41:51 -07:00
David Glasser
4e70a1db66 wrap line in README 2013-04-01 10:39:51 -07:00
David Glasser
1b679236cb Delete chaff, such as install.sh 2013-03-20 00:32:00 -07:00
Matt DeBergalis
0f6733fe3c fix meteor-core link 2012-10-29 19:13:01 -07:00
Matt DeBergalis
476ff29464 update developer resources 2012-10-29 19:12:15 -07:00
Audrey Roy
05c50867de Added a link to the instructions for contributors 2012-08-02 12:14:04 -07:00
Nick Martin
2d329d7c44 Change install instructions to be SSL now. 2012-06-27 18:17:10 -07:00
matt debergalis
32266f5d09 Merge pull request #62 from milesmatthias/docupdate
Added how to read local docs to README
2012-04-18 23:31:28 -07:00
Miles Matthias
6d57f14ec6 Added a note about how to read the docs locally, since it took me a while to figure out how to do it. 2012-04-14 18:05:58 -06:00
Jonathan Kingston
a4f656c8dd Change so read only people can clone 2012-04-13 19:38:16 +02:00
Nick Martin
e0e696387d Update github readme. 2012-04-10 12:01:54 -07:00
Nick Martin
edea43ee9b Eliminate Google Group. 2012-04-07 20:07:55 -07:00
Nick Martin
0f49ed440d Update docs for Linux support (and David) 2012-03-06 15:59:51 -08:00
Nick Martin
50d8f666ad Revert "REVERT LATER. Irc channel."
This reverts commit 2d1c5a31df.
2012-01-24 15:45:42 -08:00
Nick Martin
3c860a7b8c Revert "REVERT LATER. Change github URL."
This reverts commit 8a623d94cb.
2012-01-18 17:55:26 -08:00
Nick Martin
dc88513aca Revert "REVERT LATER. Google group."
This reverts commit 1928788b43.
2012-01-06 19:36:29 -08:00
Nick Martin
1928788b43 REVERT LATER. Google group. 2012-01-04 20:14:44 -08:00