diff --git a/README.md b/README.md index 342290a0..c410b73e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Coedit is an IDE for the [D programming language](http://dlang.org), its compilers, tools and libraries. -[![](https://github.com/BBasile/CoeditWikiData/raw/master/coedit.win7.33.png)](https://github.com/BBasile/CoeditWikiData/raw/master/coedit.win7.png) +[![](https://github.com/BBasile/Coedit/raw/master/doc/img/coedit_kde4_thumb.png)](https://github.com/BBasile/Coedit/raw/master/doc/img/coedit_kde4.png) [![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AQDJVC39PJF7J) @@ -62,16 +62,4 @@ Download the zipped binaries or the zipped setup program for you platform: **Build** --- -- 2 update 6: The procedure is described in the [**first section of the wiki**](https://github.com/BBasile/Coedit/wiki#detailed-setup-procedure) -- 3 beta (master): Confers with this [**temporary document**](https://github.com/BBasile/Coedit/wiki/Building-and-using-the-developpement-version) - -**GUI preview** ---- -Windows version (Windows 7, x86): -![Win screen-cap](https://github.com/BBasile/CoeditWikiData/raw/master/coedit.win7.png "Coedit GUI preview") - -Linux version (OpenSuse 13.2, KDE, x86_64): -![Nux screen-cap](https://github.com/BBasile/CoeditWikiData/raw/master/coedit.linux.kde.png "Coedit GUI preview") - -Linux version (Mint 17.1, Cinnamon, x86): -![Nux screen-cap](https://github.com/BBasile/CoeditWikiData/raw/master/coedit.linux.cinnamon.png "Coedit GUI preview") \ No newline at end of file +The procedure is described in [**this page**](http://bbasile.github.io/Coedit/build.html). \ No newline at end of file diff --git a/docs/img/coedit_kde4.png b/docs/img/coedit_kde4.png new file mode 100644 index 00000000..a25bcb37 Binary files /dev/null and b/docs/img/coedit_kde4.png differ diff --git a/docs/img/coedit_kde4_thumb.png b/docs/img/coedit_kde4_thumb.png new file mode 100644 index 00000000..d161597e Binary files /dev/null and b/docs/img/coedit_kde4_thumb.png differ diff --git a/docs/index.md b/docs/index.md index 310244e8..a4032b77 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,8 @@ title: index ### Coedit documentation +![](img/coedit_kde4_thumb.png) + #### First steps _Install and configure Coedit._ @@ -24,12 +26,10 @@ _General features or concepts that are not wrapped in a widget_ _Description of each entry in the main menu. May redirect to a specific widget page._ -* [File]() +* [File](menu_file) * [Debugger](widgets_gdb_commander) -* [Edit]() * [Project](features_projects) * [Project groups](widgets_project_groups) -* [Run]() #### Options categories diff --git a/docs/menu_file.md b/docs/menu_file.md new file mode 100644 index 00000000..1d399f67 --- /dev/null +++ b/docs/menu_file.md @@ -0,0 +1,32 @@ +--- +title: Widgets - application options +--- + +### File menu - reference + +- **New empty file**: Adds a new, untyped, file to the source editor. +- **New runnable module**: adds a new file with a `main()` function. See [runnables modules](features_runnables). +- **New DUB script**: adds a new file with a `main()` function and an inline DUB description. The file can be executed as a script with **Run DUB single file package** or **Run DUB single file package outside**. +- **Open file...**: Proposes to open a D source file from an open dialog. +- **Open recent**: Displays the list of the most recently opened files. +- **Close file**: Closes the current editor with an optional warning if its content is modified. +- **Close all the files**: Closes the current editors. +- **Close all the other files**: Closes the current editors expected the one that has the focus. +- **Save file**: Saves the current editor to the disk. +- **Save all**: Saves all the files currently opened. +- **Save file as...**: Proposes to save the current editor from a save dialog. +- **Export html...**: Exports the current editor to a html file with html-based highlighting. +- **Add file to project**: Adds the file matching to the current editor to the current project (CE format only). +- **Compile file**: Compiles the current file. See [runnables modules](features_runnables). +- **Compile file and run**: Compiles the current file and executes it. See [runnables modules](features_runnables). +- **Compile file and run outside**: Compiles the current file and executes without redirection. See [runnables modules](features_runnables). +- **Compile file and run...**: Compiles the current file and execute with a set of options defined in a simple input-query dialog. The arguments must be separated with spaces and can include double quotes. +- **Run compiled file**: Executes the binary produced by a previous call to **Compile file**. +- **Run compiled file outside**: Executes in a console the binary produced by a previous call to **Compile file**. +- **Run file unittests**: Compiles and runs the current file with the options **-unittest**. If the application option **coverModuleTests** is set then CE will also pass **-cov** to the compiler and reports the lines of code that are not covered by the unit tests in the messages. +- **Set runnable switches**: Allows to modify the switches passed to DMD when compiling a runnable module. One switch by line, invalid, reserved or duplicated switches are removed, for example **-main** and **-unittest** are reserved. +- **Run DUB single file package**: Compiles and execute a DUB script. +- **Run DUB single file package outside**: Compiles and execute a DUB script in a console. +- **Verify with Dscanner**: verifies the current source with [Dscanner](https://github.com/Hackerpilot/Dscanner). Results are displayed in the [messages](widgets_messages). +- **View Halstead metrics**: Checks the halstead metrics in the source that has the focus and reports abnormal functions in the [messages](widgets_messages). [Description of the metric](options_code_metrics). +- **View in mini explorer**: expands the [mini explorer](widgets_mini_explorer) tree on the folder that contains the current file. \ No newline at end of file