twisterarmy/twister-core
1
0
Fork 0
mirror of https://github.com/twisterarmy/twister-core.git synced 2025-02-02 09:54:29 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #353 from xfq/doc

Browse Source 
Doc fixes
This commit is contained in:
miguelfreitas 2015-11-01 19:17:09 -02:00
commit 1078449b80
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -25,12 +25,12 @@ Please follow the instructions for your platform:
- [UNIX](https://github.com/miguelfreitas/twister-core/blob/master/doc/build-unix.md) - [UNIX](https://github.com/miguelfreitas/twister-core/blob/master/doc/build-unix.md)
- [Debian/Ubuntu](https://github.com/miguelfreitas/twister-core/blob/master/doc/building-on-ubuntu-debian.md) - [Debian/Ubuntu](https://github.com/miguelfreitas/twister-core/blob/master/doc/building-on-ubuntu-debian.md)
- [Mac OS X](https://github.com/miguelfreitas/twister-core/blob/master/doc/build-osx.md) - [OS X](https://github.com/miguelfreitas/twister-core/blob/master/doc/build-osx.md)
- [Windows (untested)](https://github.com/miguelfreitas/twister-core/wiki/Compiling-for-Windows) - [Windows (untested)](https://github.com/miguelfreitas/twister-core/wiki/Compiling-for-Windows)
> According to our tests, at least 1GB of RAM is needed to compile Twister. > According to our tests, at least 1GB of RAM is needed to compile Twister.
Alternatively, you can run Twister on an isolated Linux container, using [Docker](http://docker.io/). First, [install Docker on your system](https://docs.docker.com/installation/#installation). Then run: Alternatively, you can run Twister on an isolated Linux container, using [Docker](https://www.docker.com/). First, [install Docker on your system](https://docs.docker.com/installation/#installation). Then run:
# Leave out the "sudo -E" if you added yourself to the "docker" group # Leave out the "sudo -E" if you added yourself to the "docker" group
sudo -E ./twister-on-docker run --remote sudo -E ./twister-on-docker run --remote

16
doc/build-osx.md
View File

@ -1,6 +1,6 @@
Mac OS X Build Instructions and Notes OS X Build Instructions and Notes
==================================== ====================================
This guide will show you how to build twisterd for OSX. This guide will show you how to build twisterd for OS X.
Notes Notes
----- -----
@ -21,13 +21,13 @@ Xcode 4.3 or later, you'll need to install its command line tools. This can
be done in `Xcode > Preferences > Downloads > Components` and generally must be done in `Xcode > Preferences > Downloads > Components` and generally must
be re-done or updated every time Xcode is updated. be re-done or updated every time Xcode is updated.
There's an assumption that you already have `git` installed, as well. If There's an assumption that you already have `git` installed, as well. If not,
not, it's the path of least resistance to install [Github for Mac](https://mac.github.com/) it's the path of least resistance to install
(OS X 10.7+) or [GitHub Desktop](https://desktop.github.com/) or
[Git for OS X](https://code.google.com/p/git-osx-installer/). It is also [Git for OS X](https://code.google.com/p/git-osx-installer/). It is also
available via Homebrew or MacPorts. available via Homebrew or MacPorts.
You will also need to install [Homebrew](http://mxcl.github.io/homebrew/) You will also need to install [Homebrew](http://brew.sh/)
or [MacPorts](https://www.macports.org/) in order to install library or [MacPorts](https://www.macports.org/) in order to install library
dependencies. It's largely a religious decision which to choose, but I tested only with dependencies. It's largely a religious decision which to choose, but I tested only with
Homebrew. Homebrew.
@ -36,7 +36,7 @@ The installation of the actual dependencies is covered in the Instructions
sections below. sections below.
Instructions: HomeBrew Instructions: Homebrew
---------------------- ----------------------
#### Install dependencies using Homebrew #### Install dependencies using Homebrew
@ -56,7 +56,7 @@ Instructions: HomeBrew
./autotool.sh ./autotool.sh
./configure --enable-logging --with-openssl=/usr/local/opt/openssl --with-libdb=/usr/local/opt/berkeley-db4 ./configure --enable-logging --with-openssl=/usr/local/opt/openssl --with-libdb=/usr/local/opt/berkeley-db4
make make
(If you have multi core CPU, use "make -j N" where N = number of your cores) (If you have multi core CPU, use "make -j N" where N = the number of your cores)
3. If things go south, before trying again, make sure you clean it up: 3. If things go south, before trying again, make sure you clean it up: