Converted README to rst

This commit is contained in:
Andrew Ahlers 2016-10-22 21:14:16 -04:00
parent 7bbc2aef0e
commit 591de2cc9f

View file

@ -1,9 +1,16 @@
====
CORE
====
CORE: Common Open Research Emulator CORE: Common Open Research Emulator
Copyright (c)2005-2013 the Boeing Company. Copyright (c)2005-2013 the Boeing Company.
See the LICENSE file included in this distribution. See the LICENSE file included in this distribution.
== ABOUT ======================================================================= About
=====
CORE is a tool for emulating networks using a GUI or Python scripts. The CORE CORE is a tool for emulating networks using a GUI or Python scripts. The CORE
project site (1) is a good source of introductory information, with a manual, project site (1) is a good source of introductory information, with a manual,
screenshots, and demos about this software. Also a supplemental screenshots, and demos about this software. Also a supplemental
@ -13,7 +20,8 @@ Google Code page (2) hosts a wiki, blog, bug tracker, and quickstart guide.
2. http://code.google.com/p/coreemu/ 2. http://code.google.com/p/coreemu/
== BUILDING CORE =============================================================== Building CORE
=============
To build this software you should use: To build this software you should use:
@ -37,7 +45,8 @@ Here is what is installed with 'make install':
See the manual for the software required for building CORE. See the manual for the software required for building CORE.
== RUNNING CORE ================================================================ Running CORE
============
First start the CORE services: First start the CORE services:
@ -50,12 +59,18 @@ Assuming the GUI is in your PATH, run the CORE GUI by typing the following:
This launches the CORE GUI. You do not need to run the GUI as root. This launches the CORE GUI. You do not need to run the GUI as root.
== SUPPORT =====================================================================
Support
=======
If you have questions, comments, or trouble, please use the CORE mailing lists: If you have questions, comments, or trouble, please use the CORE mailing lists:
- core-users for general comments and questions
http://pf.itd.nrl.navy.mil/mailman/listinfo/core-users - `core-users`_ for general comments and questions
- core-dev for bugs, compile errors, and other development issues
http://pf.itd.nrl.navy.mil/mailman/listinfo/core-dev - `core-dev`_ for bugs, compile errors, and other development issues
.. _core-users: http://pf.itd.nrl.navy.mil/mailman/listinfo/core-users
.. _core-dev: http://pf.itd.nrl.navy.mil/mailman/listinfo/core-dev