Commit Graph

86 Commits

Author SHA1 Message Date
filipenevola
5359dd8119 Updating README to include changelog link 2021-11-18 16:58:01 -04:00
Filipe Névola
3f9593d989 Update README.md 2021-11-17 07:31:27 -05:00
filipenevola
4bdc35a7f6 adding again README.md 2021-10-22 17:04:41 -04:00
Renan Castro
88cb83fec8 Add support for linux and mac os on npm meteor installer - fix instructions 2021-08-27 11:16:19 -03:00
filipenevola
6d5a51ef75 Updating references to meteor-feature-requests repository 2021-06-29 20:27:17 +04:00
denyhs
0c04a76288 changing Svelte tutorial link to the new version 2021-04-19 11:25:31 -04:00
denyhs
c59bbe0de1 changing Vue tutorial link to the website with the new version 2021-04-07 15:44:55 -04:00
denyhs
ffcfa5062c changing Blaze tutorial link to the website with the new version 2021-04-01 16:28:25 -04:00
filipenevola
0a0cae2358 Uninstalling on Windows 2021-03-18 10:14:40 -04:00
filipenevola
724d31ef30 Windows install using npm 2021-03-18 10:10:36 -04:00
Matt Hollingsworth
9750b03274 Update README.md
Fixing broken cloud link
2021-03-10 11:23:25 -08:00
filipenevola
66cf28f7a1 Update Readme with Examples link 2021-02-26 07:31:18 -04:00
filipenevola
9812a991d9 Starting to review some docs 2020-10-30 11:39:34 -04:00
Filipe Névola
96423dbd95 Updates React tutorial link to the new format 2020-09-17 18:33:12 -04:00
Harry Adel
0f427d763b Add svelte tutorial to the docs 2020-06-09 04:49:03 +02:00
Bob
11b8a3e8c5 Added Vue to list of tutorials
Added Vue with link to meteor tutorials.  Making Vue a 1st class citizen on Meteor 👍
2020-03-23 14:03:56 -07:00
Harry Adel
ba3044bcce Add Slack invite link 2020-02-21 18:19:07 +02:00
Filipe Névola
db55440041 Removes BrowserStack badge and other copy updates 2020-02-20 14:15:22 -04:00
谭九鼎
e209c7076b Chore: Use https in readme 2019-10-09 11:30:21 +08:00
Jesse Rosenberger
d746f5f472 Correct link in markdown badge. 2017-11-22 12:51:22 +02:00
Jesse Rosenberger
e8d6ab299d Update README.md to incorporate BrowserStack badge.
Hopefully, without too much effort, it will be easy to reintegrate much of
the automated BrowserStack testing we (mostly) already had in place!  In the
near future, this could be helpful for ensuring we're not over/under-shipping
polyfills to browsers.

Hopefully we can keep this green, though it's not clear to me at the
moment what additional changes I'll need to make to ensure that.  For
now, badge!
2017-11-22 12:44:51 +02:00
Hugh Willson
9caf9fd583 Adjust policy doc filenames to use capital snake case 2017-10-11 14:47:21 -04:00
Jesse Rosenberger
c6a643acf1 Tweaks to project README.md. (#9112)
Some simple messaging changes to the README to account for the fact that Meteor uses not just "pure" JavaScript, but modern JavaScript.

Additionally, link to the React and Angular tutorials, not just Blaze.
2017-09-20 11:34:22 -04:00
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