Commit graph

469 commits

Author SHA1 Message Date
Cheng Zhao
83e9521d13 Update atom-shell-vs-node-webkit.md 2016-07-01 14:27:56 +09:00
Leonard Lamprecht
67dd19ed0f Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00
Vadim Macagon
537c62a9a8 Update Build System Overview doc
`atom.gyp` was renamed to `electron.gyp` not long ago but this document wasn't updated.
2016-06-09 10:58:58 +07:00
Aaron Ang
0a03dcd481 📝 Indicate directories in the Structure of Source Code section
[ci skip]
2016-05-28 00:22:47 +02:00
Felix Rieseberg
2a7590529e 📝 Update Windows Build Instructions
Closes #5655
2016-05-24 06:12:07 -07:00
Kevin Sawicki
bfb75df49c Tweak doc headings 2016-05-17 16:02:54 -07:00
Cheng Zhao
0f52a6da39 Merge branch '1-0-release' 2016-05-11 15:14:56 +09:00
Kevin Sawicki
6861d645ad Link to vendor folder on GitHub 2016-05-06 13:25:01 -07:00
Plusb Preco
8be2239a45 📝 Match code syntax
[ci skip]
2016-05-04 14:34:11 +09:00
Daniel Pham
e9c9e22a9e 📝 Fix Windows debug doc pointing to OS X
[ci skip]
2016-05-03 11:51:57 -04:00
Cheng Zhao
0567f09d6d docs: The building environment variables 2016-05-03 08:29:23 +09:00
Cheng Zhao
e39d5a9eb9 docs: Introduce clang flags 2016-05-02 22:32:43 +09:00
Cheng Zhao
459a65d296 docs: the --build_libchromiumcontent switch 2016-05-02 16:35:33 +09:00
Cheng Zhao
64abae0b3c docs: Cleanup unnecessary parts in build-instructions-linux.md 2016-05-02 16:26:18 +09:00
Plusb Preco
6205dfa25f 📝 Remove additional whitespaces
[ci skip]
2016-04-22 23:30:41 +09:00
Plusb Preco
741f8091b4 📝 Fix coding style issues
* Correct heading order
* Adjust line length to `80`
* Beautify docs
* Apply small fixes
* Normalize whitespaces

[ci skip]
2016-04-22 23:09:59 +09:00
Plusb Preco
4f4277e25e 📝 Fix coding style issues
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-04-22 22:54:43 +09:00
Cheng Zhao
652110707e Merge pull request #5202 from electron/updating-submodules
keeping submodules up to date
2016-04-20 10:51:12 +09:00
Cheng Zhao
5b7637687c Merge pull request #5143 from felixrieseberg/debug-instructions
Add Debugging Instructions for Windows
2016-04-20 09:33:25 +09:00
Zeke Sikelianos
8f04dd1b9c remove the git 2016-04-19 09:46:48 -07:00
Zeke Sikelianos
916114dd28 📝 keeping submodules up to date 2016-04-18 20:23:11 -07:00
Felix Rieseberg
3c6e933231 📝 Add Debugging Instructions for Windows
Ref #5140
2016-04-13 15:39:05 -07:00
Zeke Sikelianos
348a0e958b wrap cases in backticks 2016-04-07 09:49:55 -07:00
Zeke Sikelianos
4d8d4d5f2a use globalShortcut as a better mixedCase example 2016-04-07 09:49:17 -07:00
Zeke Sikelianos
193c6d6e93 📝 document API naming conventions 2016-04-07 09:40:31 -07:00
Kevin Sawicki
102f7e8e33 Update docs for new org 2016-04-04 12:05:53 -07:00
Cheng Zhao
7023528042 Merge pull request #4909 from atom/standard
Use `standard` JavaScript Style
2016-04-01 11:13:56 +09:00
Plusb Preco
a648528f43 📝 Normailze note markers
* Normalize note markers syntax `__` to `**`

[ci skip]
2016-03-31 14:22:28 +09:00
Zeke Sikelianos
f25c3d33b6 mention standard in coding style doc 2016-03-30 17:00:05 -07:00
Rodrigo Ramírez Norambuena
c4128e6b4b add curl package into Ubuntu section missing for the build 2016-03-25 23:47:47 -03:00
Kevin Sawicki
8839cc51c2 Update source tree docs for new layout 2016-03-24 14:47:31 -07:00
Zeke Sikelianos
5acfa8611a link to gyp 2016-03-16 13:15:34 -07:00
Zeke Sikelianos
6503f32ef9 add another link to ninja 2016-03-16 09:47:12 -07:00
Zeke Sikelianos
da47b569e8 link to the ninja website 2016-03-16 09:42:33 -07:00
Kevin Sawicki
04c8bc38b2 Tweak lint sentence 2016-03-07 13:58:49 -08:00
Kevin Sawicki
1c68aae43e Mention npm run lint 2016-03-07 09:46:05 -08:00
Kevin Sawicki
686af28f54 Mention indent and semicolons 2016-03-07 09:45:13 -08:00
Kevin Sawicki
6725523042 Remove CoffeeScript from styleguide 2016-03-07 09:43:04 -08:00
Prayag Verma
d8086b6532 docs: fix minor typo
Replace `an` with `a`
2016-02-01 14:40:36 +05:30
Cheng Zhao
e3d3cd1198 docs: Update link of VS Community
Also fix the version of VS requried.

Close #3962.
2016-01-11 20:52:32 +08:00
Frank Laub
ab53e04a80 s/Phrase/Phase 2015-12-24 23:04:44 -08:00
Brian R. Bondy
8ae99ebd1f Indicate that Update 5 is required for VS2013 2015-12-12 22:25:45 -05:00
Cheng Zhao
68099a71b0 docs: Use absolute URLs
Relative paths in GitHub's repo do not work very well, and our docs site
can not recognize them.
2015-11-17 11:47:57 +08:00
Sunny
9ac87e844a Fix node_bindings link in Simplified Chinese document translation 2015-11-13 15:41:20 +08:00
Jessica Lord
bd20104e5a Merge master 2015-09-02 10:19:08 -07:00
Vishesh Handa
17cc43152d Linux Build Instructions: Add list of packages for fedora 2015-09-01 16:01:44 +02:00
Jessica Lord
889c982918 Source code structure as tree command 2015-08-31 21:49:05 -07:00
Jessica Lord
691d8dd9ab Replace "Mac" with "OS X" 2015-08-31 21:13:05 -07:00
Jessica Lord
316210d6c4 Add $ notation 2015-08-31 21:10:48 -07:00
Jessica Lord
2c79e9fd41 Standardize dir structure 2015-08-30 22:31:43 -07:00
Jessica Lord
29c865f0e1 Standardize symbol server 2015-08-30 22:31:25 -07:00
Jessica Lord
e0542945ce Standardize code style 2015-08-30 22:31:14 -07:00
Jessica Lord
842ba6aea6 Standardize overview 2015-08-30 22:31:07 -07:00
Jessica Lord
009e228218 Standardize build win 2015-08-30 22:30:36 -07:00
Jessica Lord
d93b6c1cae Standardize build mac 2015-08-30 22:30:23 -07:00
Jessica Lord
2206279846 Standardize build linux 2015-08-30 22:30:12 -07:00
Jessica Lord
1e5b7af490 Standardize atom vs nw 2015-08-30 22:30:01 -07:00
Eran Tiktin
5337d8c23f Ignore native module tests on Windows debug build
This resolves #2558. There are no more errors when running test.py on
the debug build in Windows. When running the release build the tests
will be executed as usual.
2015-08-27 23:05:06 +03:00
Eran Tiktin
5a8f60fe32 Update build-instructions-windows
The build instructions mistakenly said that you can find `atom.exe` under `out\D` instead of `electron.exe`. I fixed that and mentioned that the release build will be to `out\R`.
2015-08-25 23:28:41 +03:00
Cheng Zhao
ce0509a665 Merge pull request #2554 from etiktin/patch-4
Update coding-style with info about Chromium's types
2015-08-25 13:41:54 +08:00
Jessica Lord
3f52a91312 Create directory for KO translations 2015-08-22 14:21:01 +02:00
Eran Tiktin
79c602c3cc Update coding-style with info about Chromium's types
When I first tried to add something to the C++ code, I was a bit overwhelmed by all the special types and abstractions.
The info added will hopefully make it a bit easier to start, by directing users to the right place.
2015-08-21 22:23:49 +03:00
Cheng Zhao
01921ee6fa Merge branch 'master' of https://github.com/preco21/electron into preco21-master
Conflicts:
	docs/api/browser-window-ko.md
2015-08-21 11:30:47 +08:00
Plusb Preco
ad24c11f32 Merge remote-tracking branch 'atom/master' 2015-08-21 11:41:07 +09:00
Plusb Preco
172cc22d90 Fix some typos, update as upstream 2015-08-20 07:50:07 +09:00
Olivier Forget
092f9d2c46 Clarify that MSVS 2015 will not work in Windows build docs. 2015-08-14 10:25:18 -07:00
Cheng Zhao
ebfd03570f Merge pull request #2456 from etiktin/update_build_md
Add a comment to build instructions about cpplint
2015-08-10 11:21:51 +08:00
Plusb Preco
40c7e6e179 Update as upstream, translate 2 files, fix some typos 2015-08-10 03:33:32 +09:00
Eran Tiktin
de441916d6 Add a comment to build instructions about cpplint
I added a mention of `cpplint.py` in the build instructions.
The reason, is because it's easy to miss it's existence. Even if you
noticed it's mentioned in `coding-style.md` you might mistakenly think
that `test.py` runs it).
2015-08-08 23:25:27 +03:00
Jiaji Zhou
e0a117414b Add missing dependency for ubuntu build
I tried to follow the document to build electron on a fresh clean built Ubuntu 15.04.
I encountered the following error message when trying to run ./script/bootstrap.py -v

Package nss was not found in the pkg-config search path. 
Perhaps you should add the directory containing `nss.pc' 
to the PKG_CONFIG_PATH environment variable 
No package 'nss' found 

After installing libnss3-dev, the build can pass.
2015-07-30 01:21:17 -07:00
Plusb Preco
05def654c3 Translate web-view-tag-tag-ko.md, improve grammer 2015-07-30 09:56:27 +09:00
Plusb Preco
b524914008 Update as upstream 2015-07-15 08:30:02 +09:00
Plusb Preco
e510384375 Revert "Revert "Update APIs, check grammars""
This reverts commit 5e083473e7b4d3a6014d35e68618594765151afe.
2015-07-15 08:09:03 +09:00
Plusb Preco
eb81810a52 Revert "Update APIs, check grammars"
This reverts commit d1eb971263f72deae84541d12b3bdd6d5972365a.
2015-07-15 08:09:01 +09:00
Plusb Preco
3b2f3c3152 Update APIs, check grammars 2015-07-15 08:08:59 +09:00
Plusb Preco
de5bc32d0b Fix typos, update some files 2015-07-15 08:08:57 +09:00
Cheng Zhao
e5f852d7d5 docs: Adds the dependencies of arm target
Close #2181
2015-07-13 15:26:35 -07:00
Cheng Zhao
3064afbac4 Merge pull request #2119 from deepak1556/linux_doc_patch
doc: linux troubleshooting libtinfo.so.5 not found
2015-07-06 12:29:40 +08:00
Cheng Zhao
07cf2eac4e Merge pull request #2113 from atom/libchromiumcontent-mirror
Allow downloading prebuilt libchromiumcontent binaries from mirror
2015-07-06 09:52:43 +08:00
Haojian Wu
f5b502186b 📝 Add mirror address description. 2015-07-05 22:50:36 +08:00
Cheng Zhao
4e94e0c82f Merge pull request #2093 from preco21/master
Translate docs into korean #2 + added link of power-save-blocker API to README
2015-07-05 21:21:56 +08:00
Robo
c7518f84f8 doc: linux troubleshooting libtinfo.so.5 not found 2015-07-04 10:52:18 +05:30
Cheng Zhao
5ccc909f2f Merge pull request #2094 from atom/arm
Add arm build
2015-07-02 16:04:37 +08:00
Cheng Zhao
a367934b95 docs: Cross compilation 2015-07-02 15:55:21 +08:00
Shaine Ismail
11cfe20395 Update build-instructions-windows.md
Very very very minor typo
2015-06-30 13:00:20 +01:00
Plusb Preco
fcf4da1097 Fix charsets, add more translated files 2015-06-29 21:41:11 +09:00
Plusb Preco
ebb031dafe Fix typos, add more files 2015-06-26 13:06:12 +09:00
Plusb Preco
bf5b084945 Fix some typos and translate more files 2015-06-26 13:06:10 +09:00
Plusb Preco
30dfd54575 First translation
Translate docs to korean
2015-06-22 14:06:06 +09:00
BobCochran
f776932718 Edited virtual machines sections. 2015-06-07 08:11:44 -04:00
BobCochran
40b6a1a37c Add instructions to clean build products 2015-06-06 18:04:11 -04:00
BobCochran
8a2b665097 Edit linux build instructions based on feedback 2015-06-05 19:38:30 -04:00
BobCochran
ed244648d0 Update build instructions for Linux 2015-06-04 21:03:45 -04:00
Cheng Zhao
3c186946eb docs: python 2.7 is required, close #1830 2015-06-03 19:27:04 +08:00
Cheng Zhao
6ed538b952 docs: Remove obsolete build instructions, close #1809 2015-05-29 18:21:25 +08:00
Ben Drucker
0e7970fec5 Fix grammar in NW.js comparison 2015-04-27 15:55:25 -04:00
lazarus
00ef99826d fix minor text error 2015-04-23 16:32:41 -07:00
Cheng Zhao
1f1cb12d46 docs: Build for 64bit target on Windows 2015-04-16 14:50:46 +08:00
Cheng Zhao
d2682233fd docs: Atom Shell => Electron 2015-04-16 11:31:12 +08:00
Cheng Zhao
43fe82e1e5 Merge branch 'master' into rename-to-electron 2015-04-12 21:49:08 +08:00
Cheng Zhao
252ac465c5 Merge pull request #1384 from atom/component_build
Links with Chromium directly instead of linking its shared library
2015-04-11 14:12:16 +08:00
Joshua Bemenderfer
4defde0b61 Fix spelling and grammar errors.
Particularly in the spelling of the bootstrap and build script names. That threw me off a bit.
2015-04-11 12:46:13 +08:00
Cheng Zhao
ab94c3f49e docs: Add "Build system overview" chapter 2015-04-11 12:11:57 +08:00
Cheng Zhao
21ca4de1af docs: Output dir is changed 2015-04-10 21:56:02 +08:00
Kevin Sawicki
6615ef1054 Atom Shell -> Electron 2015-04-08 10:16:10 -07:00
Cheng Zhao
c2852b5b8c linux: Add some more building requirements 2015-04-08 19:46:37 +08:00
Joshua Benuck
0de623693d Update build-instructions-windows.md
In the troubleshooting section, include a recommendation to install the latest Visual Studio update if you run into a fatal internal compiler error while building.
2015-04-03 20:22:50 -07:00
Joseph Dykstra
b6875ad49b Renamed browser-side to main process
renamed a few occurances of "web page" to "renderer"
renamed a few files that had "browser" in their name to "main-process"
note that there are still many occurances of web page.
2015-03-26 10:20:31 -05:00
Cheng Zhao
b19cfba98e Merge pull request #1240 from suyash/rename-node-webkit-to-nwjs
rename node-webkit to NW.js in development docs
2015-03-18 18:01:37 +08:00
Suyash
327c7bc3cc 📝 avoid breaking everyone's stuff 2015-03-16 16:50:23 +05:30
Suyash
cda129b073 📝 rename node-webkit to NW.js in development docs
Replaces all occurences of node-webkit with NW.js in the development
docs.
2015-03-12 01:58:58 +05:30
Suyash
860b15ef8a 📝 add troubleshooting instructions for libudev.so.0 failure
Adding the easiest solution for solving the missing libudev.so.0 error
on ubuntu 13.04+.

I had to do this on my own machine running ubuntu 14.04.2 to build atom.

The solution is also referenced in
https://github.com/nwjs/nw.js/wiki/The-solution-of-lacking-libudev.so.0
2015-03-11 12:17:22 +05:30
Xue Fuqiao
5083a7505d Change Mac OS X to OS X.
Apple has renamed Mac OS X to OS X.
2015-02-02 16:21:23 +08:00
Cheng Zhao
c5411c3291 docs: Add troubleshooting for runnin on Git Bash, closed #711 2014-12-29 19:09:36 -08:00
IgorKlopov
27710cd4f7 bootstrap.py -v in mac 2014-12-08 20:07:29 +03:00
IgorKlopov
4d5bbbc2d7 bootstrap.py -v 2014-12-08 20:07:00 +03:00
IgorKlopov
2153e018a3 Bootstrap indeed 2014-12-07 18:47:23 +03:00
IgorKlopov
3f4fec0864 Why not verbose?
The silence are scary
2014-12-07 18:46:12 +03:00
Paul Betts
d07482c5f6 Add a paragraph about modern.ie 2014-11-14 19:21:12 -08:00
Paul Betts
26ac34d0e0 Come Correct with 80-char wrapping 2014-11-14 19:21:04 -08:00
Paul Betts
c99b20206c Misc copy fixups 2014-11-14 19:15:11 -08:00
Paul Betts
d97155d7b0 Point people towards VS2013 Community Edition 2014-11-14 19:14:27 -08:00
Paul Betts
10af87008d Remove Cygwin suggestion 2014-11-14 19:14:10 -08:00
Paul Betts
ed633b3250 Powershell'ify everything 2014-11-14 19:13:40 -08:00
Cheng Zhao
e0fddcb7ce Merge pull request #826 from statico/patch-1
Update Windows build instructions
2014-11-15 10:52:12 +08:00
Cheng Zhao
7943f7f7eb linux: Link necessary libraries
This fixes linking problem on some systems, see #500.
2014-11-15 10:16:48 +08:00
Ian Langworth ☠
bef6909218 Update Windows build instructions
I encountered a few problems when trying to build atom-shell under Windows.
2014-11-13 19:11:56 -08:00
Cheng Zhao
4a1b6d76b2 docs: Update symbol server address 2014-11-10 23:24:13 +08:00
Cheng Zhao
621867e518 docs: Setting up symbol server in debugger 2014-11-10 16:09:13 +08:00
Cheng Zhao
5b167e3684 Mention clang 3.4 is required, refs #735 2014-10-24 09:55:31 +08:00
Cheng Zhao
b06d59fcb2 linux: Add libdbus-1-dev as requirement 2014-10-21 15:01:24 +08:00
Cheng Zhao
c019f13e8c docs: Update prerequisities in Windows build instructions. 2014-08-11 09:39:03 +08:00
Cheng Zhao
a76ae8cd35 docs: Remove the outdated 32bit note in linux build instructions. 2014-08-05 22:44:21 +08:00
Corné Dorrestijn
ad1efa67bc Add troubleshooting information for #500 2014-08-05 13:33:38 +02:00
Cheng Zhao
64bf1bcb9f Move all chromium's code under chromium_src. 2014-06-29 06:06:35 +00:00
Cheng Zhao
5d4f1e3c00 Update build instructions for VS2013. 2014-06-27 11:08:00 +08:00
Cheng Zhao
4c5a306733 📝 Mention a new Windows build error. 2014-06-25 09:11:06 +08:00
Cheng Zhao
70c96eeac6 📝 frameworks => external_binaries. 2014-05-21 22:41:46 +08:00
Cheng Zhao
c2efc4aeb3 📝 Remove unneeded install dependency on Ubuntu. 2014-05-21 22:38:17 +08:00
Cheng Zhao
1b3fc53a95 Merge pull request #322 from pullreq/patch-1
10.8+, preexisting node required.
2014-05-18 20:17:19 +08:00
Cheng Zhao
c407588821 📝 Add usage of VS console in troubleshooting, regarding #306. 2014-05-18 19:59:43 +08:00
Geoff Nixon
75ce386065 10.8+, preexisting node required.
I'm presently giving 10.7 support the old college try (building against the 10.7 SDK with Xcode 5.1, not necessarily supporting the Xcode 4.6 toolchain), but I thought this should be updated in the meantime. It also seems possible to me that the pre-installed node requirement is somewhat accidental. Since we have the source checked out already, it should be rather trivial to build an intermediate "bootstrap" node if there isn't one found in the path. Do it?
2014-05-15 18:07:08 -07:00
Cheng Zhao
f2281957ce 📝 VS2010 SP1 is required, fixes #306. 2014-05-15 14:32:34 +08:00
Cheng Zhao
d38bc95f04 📝 More instructions on installing under Ubuntu, closes #315. 2014-05-15 14:13:41 +08:00
Greg Mefford
257964d13e Doc: grammatical fixes in Windows build docs
Minor documentation changes to fix typos and clarify some phrasing
2014-05-09 22:11:17 -04:00
Cheng Zhao
1321fb8151 Assume users are using Xcode 5.1. 2014-05-09 10:04:49 +08:00
Jakukyo Friel
123e20c688 doc atom-shell-vs-node-webkit: typo 2014-05-08 15:38:28 +08:00
Pascal Borreli
831c7f5924 Fixed typos 2014-05-07 07:34:53 +01:00
andy matthews
f263a8e9d5 Capitilization, grammar, and punctuation changes 2014-05-07 00:06:35 -05:00
Dan Schuman
0c9794eefa Update atom-shell-vs-node-webkit.md 2014-05-06 09:52:24 -07:00
Dan Schuman
2a22a47322 missing adjective =) 2014-05-06 09:46:29 -07:00
Cheng Zhao
444a094eda Fix subtitle 2014-05-06 15:22:29 +08:00
Cheng Zhao
5eb2b33018 📝 Add technical differences to node-webkit, fixes #242. 2014-05-06 15:16:54 +08:00
Cheng Zhao
5b5651882e Squirrel.Mac is open sourced. 2014-05-06 11:22:03 +08:00
Cheng Zhao
37275c64cd 📝 Mention 64/32 bit support on each platform. 2014-05-05 09:48:44 +08:00
Cheng Zhao
9b9cfcfeaa 📝 Update source code structure. 2014-05-04 20:15:20 +08:00
Cheng Zhao
b6fa1141fe 📝 Add troubleshooting in windows build instructions. 2014-04-29 11:07:17 +08:00
Cheng Zhao
eaab9b295b 📝 Update docs for new source code structure. 2014-03-16 09:17:45 +08:00
Cheng Zhao
09ebabfc45 📝 Revise the build instructions on Linux. 2014-03-13 14:20:48 +08:00
Cheng Zhao
679aa43113 📝 List libraries required for Linux. 2014-02-20 18:56:59 +08:00
Cheng Zhao
2b82eafff4 📝 Update docs on using native modules. 2014-02-20 18:51:57 +08:00
Cheng Zhao
94b3de557e 📝 Add docs on building for Linux. 2014-02-20 18:39:24 +08:00
Cheng Zhao
b2d4d76bcf 📝 Update docs on source code structure. 2014-01-16 10:31:59 +08:00
Kyle Robinson Young
c116f6b35c Fix a couple minor typos in docs 2013-12-12 22:31:19 -08:00
Cheng Zhao
9ac5ea5a6c Mention that pyobjc is needed for homebrew python. 2013-11-26 11:46:45 +08:00
Cheng Zhao
362bb6e68b Mention required options of WDK and Win7 SDK, fixed #114. 2013-10-31 20:06:36 +08:00
Cheng Zhao
602f02b867 💄 Fix typo of doc. 2013-10-26 18:09:22 +08:00
Cheng Zhao
5cf61c9ab4 Add more details on building with VS 2010 Express. 2013-10-26 18:07:20 +08:00
Cheng Zhao
92241b91ce doc: Separate pages into sub directories. 2013-09-09 15:49:13 +08:00