Commit graph

332 commits

Author SHA1 Message Date
John Schmidt
38342fbe48 📝 Redirect dead link [ci skip] 2017-09-10 08:27:10 -04:00
Vanessa Yuen
4fb800a899 more docs edit 2017-09-06 16:44:41 -04:00
Vanessa Yuen
a81ea1ffde Update release documentation to reflect new usage of bump-version script. 2017-09-06 16:41:51 -04:00
John Kleinschmidt
14eea98566 Merge pull request #10333 from electron/more-releasing-tips
add more releasing tips
2017-08-30 10:42:59 -04:00
Zeke Sikelianos
e1c4962312 add sh to code fences 2017-08-28 08:41:52 -07:00
Tony Ganch
6a285e2e76 Update Chromium Upgrade docs 2017-08-27 17:51:47 +03:00
Aleksei Kuzmin
c4634f7e98 Update Chromium Upgrade docs 2017-08-27 17:51:47 +03:00
Zeke Sikelianos
88b3109137 change backport branch creation steps 2017-08-22 21:03:03 -07:00
Cheng Zhao
a419fe75ca Merge pull request #10253 from electron/improvements-for-libcc-development
Improve development workflow with built libchromiumcontent
2017-08-15 19:40:06 +09:00
Thiago de Arruda
d6fbf5f1bb Improve development workflow with built libchromiumcontent
- Add `--debug_libchromiumcontent` to build libchromiumcontent for debugging
  (shared library build).
- By default, only invoke `gclient sync` the first time to checkout chromium
  source tree. Add `--force_update_libchromiumcontent` switch to force updating.
- Document new options.

The goal is to allow faster edit/compile cycles when debugging/making changes
to libchromiumcontent.
2017-08-15 05:40:22 -03:00
Zeke Sikelianos
fd6aeda6f6 edit release on github after promoting to latest 2017-08-10 20:53:02 -07:00
Zeke Sikelianos
404589d9b5 add more releasing tips 2017-08-10 09:26:22 -07:00
Zeke Sikelianos
e8af45e130 document npm promotion 2017-08-03 13:24:18 -07:00
Zeke Sikelianos
01283c26a8 improve the releasing guide 2017-08-03 12:55:33 -07:00
John Kleinschmidt
b17d34a88c Update with better instructions for building libchromiumcontent 2017-07-28 16:27:33 -04:00
Zeke Sikelianos
c62d1bbf41 improve linux build instructions 2017-07-27 10:29:41 -07:00
Zeke Sikelianos
34c27468dd fix typo in macOS debugging doc 2017-07-17 12:12:44 -07:00
Zeke Sikelianos
57d81f6961 fix typo in linux build instructions 2017-06-19 08:45:06 -07:00
Xaver Hellauer
ded1adf165 Clang-Format extension for Visual Studio Code 2017-05-12 18:40:46 +02:00
Kevin Sawicki
94eff35286 Update docs for new brightray location 2017-05-10 13:42:21 -07:00
Kevin Sawicki
9acd9e878c Mention downloading debugging tools for windows 2017-04-21 08:37:01 -07:00
Kevin Sawicki
740de02d6c builds -> Support 2017-03-30 14:36:52 -07:00
Kevin Sawicki
5b4f715d2e Add test page to check for proprietary codecs 2017-03-30 14:36:52 -07:00
Hari Juturu
d95114016d V8 dev resources (#9008)
* Adding V8 documentation links

* Removing extra space

* use electron markdown conventions

* cross-link v8 and chromium dev docs

* fix v8 link
2017-03-24 15:40:23 -07:00
Zeke Sikelianos
360d2b45f4 document resources for tracking chromium development 2017-03-22 22:59:11 -07:00
Kevin Sawicki
2d638e5da7 Add option to clean.py to only remove dist and out dirs 2017-03-20 10:33:04 -07:00
Adham Saad
8060b0966f 🐛 #8919 - fix typo 2017-03-17 20:47:20 +02:00
Adham Saad
487a195320 🐛 #8919 - add new command to the docs 2017-03-17 20:44:18 +02:00
Zeke Sikelianos
15bf7ed536 use https URLs for images 2017-02-28 21:24:31 -08:00
Kevin Sawicki
de18f09588 Add initial upgrading chrome checklist 2017-02-03 09:54:34 -08:00
Kevin Sawicki
4f6750a460 Update build doc to Xcode 8.2.1 2017-01-24 10:49:42 -08:00
Kevin Sawicki
91c70a66cb Link to Xcode 7.3.1 DMG 2017-01-20 08:16:17 -08:00
Birunthan Mohanathas
b145131505 Mention VS2015 Update 3 to match CI environment 2017-01-20 07:19:43 +02:00
Birunthan Mohanathas
410f3c03d4 Document use of Xcode 7.3.1 with 10.10 SDK for release builds 2017-01-20 07:19:07 +02:00
Phil Wyett
2fbf560668 Commit...
* Update build instructions to correctly reflect python version on CentOS
  that has Python 2.6.
* Correct Fedora package install command. Fedora now uses 'dnf' not 'yum'.
* Add RHEL / CentOS section that does use 'yum' for package install.
2016-12-15 03:05:24 +00:00
Kevin Sawicki
acacb3f551 Update symbols server URL 2016-11-07 10:58:27 -08:00
Kevin Sawicki
e2c646a14b Push after bumping 2016-10-20 11:34:51 +09:00
Zeke Sikelianos
63267031e9 💲 2016-10-20 11:30:36 +09:00
Zeke Sikelianos
88b288502a Add note about Python HTTPS warning 2016-10-20 11:29:02 +09:00
Zeke Sikelianos
b0fb0c6492 Document S3 creds 2016-10-20 11:22:32 +09:00
Zeke Sikelianos
3a44663003 Add note about setting $ELECTRON_GITHUB_TOKEN 2016-10-20 11:19:18 +09:00
Zeke Sikelianos
7a73c0189f bump-release -> bump-version 2016-10-19 11:40:40 +09:00
Zeke Sikelianos
6b207d65bf update releasing 2016-10-18 14:04:52 +09:00
Zeke Sikelianos
82a16ee41f document the electron release process 2016-10-18 13:41:57 +09:00
Zeke Sikelianos
37c53f2e09 clarify mocha test exclusion 2016-10-11 14:22:48 -07:00
Zeke Sikelianos
a8e59ccd3d fix links to testing docs 2016-10-11 14:22:48 -07:00
Zeke Sikelianos
57852366bb mention building before testing 2016-10-11 14:22:48 -07:00
Zeke Sikelianos
a4832c304e unify testing docs for all platforms 2016-10-11 14:22:48 -07:00
Zeke Sikelianos
0aeb53435e add tips for testing 2016-10-11 14:22:48 -07:00
Dan Burzo
75feeca0f0 Small fix to grammar in Build instructions (macOS) 2016-10-11 17:41:28 +03:00
Dan Burzo
120aa1c9ce Adds link to PyObjC installation instructions 2016-10-11 17:34:35 +03:00
Kevin Sawicki
f872799f5c Minor edits to clang-format guide 2016-10-07 14:05:33 -07:00
Haojian Wu
0d930b65f1 📝 clang-format on Electron C++ code. 2016-10-05 22:12:48 +02:00
Kevin Sawicki
a723d17f49 Mention cleaning on all three platforms 2016-09-21 11:10:52 -07:00
Joshua Anderson
56b40ae6d2
Update nodejs requirement for building on linux 2016-09-13 19:41:53 -07:00
Will Eccles
488fe53276 fixed grammar for 32bit 2016-08-18 08:56:12 -07:00
Zeke Sikelianos
515e25b749 source files DO have newlines at the end 2016-08-16 21:24:53 -07:00
Kevin Sawicki
252aca8834 Add gperf and bison to package install commands 2016-08-10 17:34:58 -07:00
Felix Rieseberg
ab69ae07b7 📝 Add debugging instructions for macOS
I already wrote up debugging instructions for Windows, but never got
around to writing them for macOS - until now! This adds a very basic
introduction to LLDB from the command line, which should empower people
to figure out what’s happening inside Electron when they call an
Electron method from JavaScript.
2016-07-29 10:19:58 -07:00
Cheng Zhao
89de791e9d docs: Mention the --msvs 2016-07-26 17:42:12 +09:00
Cheng Zhao
b34deb1d2f docs: x64 is the default build 2016-07-26 17:40:58 +09:00
Cheng Zhao
c70635daff docs: Some dlls are not there anymore 2016-07-07 10:17:49 +09:00
Jonathan Sampson
7baf7372af modern.ie is no longer in use
The URL exists for historical reasons, but is no longer the primary URL for developer resources.
2016-07-05 19:34:33 -07:00
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