From bb04462294ec45b2bd41398ef1aae663a0df703d Mon Sep 17 00:00:00 2001 From: Ted Zhang Date: Tue, 16 Mar 2021 10:00:16 -0400 Subject: [PATCH] modify README --- README | 46 ---------------------------------------------- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 46 insertions(+), 47 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index db82127..0000000 --- a/README +++ /dev/null @@ -1,46 +0,0 @@ -CellOrganizer -------------- - -For generating 3D images, using a computer with at least 2 GB of memory is recommended. - -I. Installation ---------------- -To install CellOrganizer - -(1) Download the latest distribution from - -http://www.cellOrganizer.org - -or - -http://murphylab.web.cmu.edu/software/CellOrganizer - -(2) Unzip the distribution into a folder of your choice - -(3) Start Matlab and change the default directory to the folder chosen above - -II. Using CellOrganizer via the Graphical User Interface - -Enter "startup" at the Matlab command prompt - -III. Using CellOrganizer from the Matlab command line - -Enter "startup" at the Matlab command prompt to add the relevant paths. The main CellOrganizer commands are - -> img2slml - -which trains a model from a set of images - -and - -> slml2img - -which synthesizes one or more image(s) from a trained model. - -IV. Examples using the Matlab command line - -There are a numbers of demo files that illustrate how to use CellOrganizer from the command line. Type - -> demoinfo - -to get a listing of available demos. diff --git a/README.md b/README.md index 059fcf7..db82127 100644 --- a/README.md +++ b/README.md @@ -1 +1,46 @@ -# cellorganizer +CellOrganizer +------------- + +For generating 3D images, using a computer with at least 2 GB of memory is recommended. + +I. Installation +--------------- +To install CellOrganizer + +(1) Download the latest distribution from + +http://www.cellOrganizer.org + +or + +http://murphylab.web.cmu.edu/software/CellOrganizer + +(2) Unzip the distribution into a folder of your choice + +(3) Start Matlab and change the default directory to the folder chosen above + +II. Using CellOrganizer via the Graphical User Interface + +Enter "startup" at the Matlab command prompt + +III. Using CellOrganizer from the Matlab command line + +Enter "startup" at the Matlab command prompt to add the relevant paths. The main CellOrganizer commands are + +> img2slml + +which trains a model from a set of images + +and + +> slml2img + +which synthesizes one or more image(s) from a trained model. + +IV. Examples using the Matlab command line + +There are a numbers of demo files that illustrate how to use CellOrganizer from the command line. Type + +> demoinfo + +to get a listing of available demos.