From 591de2cc9f42702c87b3262de050728800100306 Mon Sep 17 00:00:00 2001 From: Andrew Ahlers Date: Sat, 22 Oct 2016 21:14:16 -0400 Subject: [PATCH 1/2] Converted README to rst --- README => README.rst | 61 +++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 23 deletions(-) rename README => README.rst (50%) diff --git a/README b/README.rst similarity index 50% rename from README rename to README.rst index c3004eb0..e119377d 100644 --- a/README +++ b/README.rst @@ -1,9 +1,16 @@ +==== +CORE +==== CORE: Common Open Research Emulator + Copyright (c)2005-2013 the Boeing Company. + 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 project site (1) is a good source of introductory information, with a manual, screenshots, and demos about this software. Also a supplemental @@ -13,49 +20,57 @@ Google Code page (2) hosts a wiki, blog, bug tracker, and quickstart guide. 2. http://code.google.com/p/coreemu/ -== BUILDING CORE =============================================================== +Building CORE +============= To build this software you should use: - ./bootstrap.sh - ./configure - make - sudo make install + ./bootstrap.sh + ./configure + make + sudo make install Here is what is installed with 'make install': - /usr/local/bin/core-gui - /usr/local/sbin/core-daemon - /usr/local/sbin/[vcmd, vnoded, coresendmsg, core-cleanup.sh] - /usr/local/lib/core/* - /usr/local/share/core/* - /usr/local/lib/python2.6/dist-packages/core/* - /usr/local/lib/python2.6/dist-packages/[netns,vcmd].so - /etc/core/* - /etc/init.d/core + /usr/local/bin/core-gui + /usr/local/sbin/core-daemon + /usr/local/sbin/[vcmd, vnoded, coresendmsg, core-cleanup.sh] + /usr/local/lib/core/* + /usr/local/share/core/* + /usr/local/lib/python2.6/dist-packages/core/* + /usr/local/lib/python2.6/dist-packages/[netns,vcmd].so + /etc/core/* + /etc/init.d/core See the manual for the software required for building CORE. -== RUNNING CORE ================================================================ +Running CORE +============ First start the CORE services: - sudo /etc/init.d/core-daemon start + sudo /etc/init.d/core-daemon start This automatically runs the core-daemon program. Assuming the GUI is in your PATH, run the CORE GUI by typing the following: - core-gui + core-gui 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: -- core-users for general comments and questions - http://pf.itd.nrl.navy.mil/mailman/listinfo/core-users -- core-dev for bugs, compile errors, and other development issues - http://pf.itd.nrl.navy.mil/mailman/listinfo/core-dev + +- `core-users`_ for general comments and questions + +- `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 From f80304384ab72a6dace1a0ffa42500ff5c9ccb16 Mon Sep 17 00:00:00 2001 From: Andrew Ahlers Date: Sat, 22 Oct 2016 21:18:17 -0400 Subject: [PATCH 2/2] Added direct link to manual --- README.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e119377d..113fba6b 100644 --- a/README.rst +++ b/README.rst @@ -16,8 +16,13 @@ project site (1) is a good source of introductory information, with a manual, screenshots, and demos about this software. Also a supplemental Google Code page (2) hosts a wiki, blog, bug tracker, and quickstart guide. - 1. http://www.nrl.navy.mil/itd/ncs/products/core - 2. http://code.google.com/p/coreemu/ +1. http://www.nrl.navy.mil/itd/ncs/products/core + +2. http://code.google.com/p/coreemu/ + +3. `Official Documentation`_ + +.. _Official Documentation: http://downloads.pf.itd.nrl.navy.mil/docs/core/core-html/index.html Building CORE