Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
algorys committed Feb 21, 2018
1 parent bc91dce commit e8d6fdc
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,17 @@ CMake Converter
.. image:: http://readthedocs.org/projects/cmakeconverter/badge/?version=develop
:target: http://cmakeconverter.readthedocs.io/en/develop/?badge=develop
:alt: Documentation Status
.. image:: https://badge.fury.io/py/cmake_converter.svg
:target: https://badge.fury.io/py/cmake_converter
:alt: Most recent PyPi version
.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
:target: http://www.gnu.org/licenses/agpl-3.0
:alt: License AGPL v3

Introduction
------------

This project aims to facilitate the conversion of Visual Studio projects to CMake projects. The goal is to give to a Python script, a **.vcxproj** file, and output a **CMakeLists.txt**.
This project aims to facilitate the conversion of Visual Studio projects to CMake projects.
The goal is to give to a Python script, a **.vcxproj** file, and output a **CMakeLists.txt**.

**Note :** Actually, it's **only works** with `c/c++` projects.
**Note :** Actually, it's **only works** with ``C/C++`` projects.

Quick Install & Run
-------------------
Expand All @@ -48,7 +46,7 @@ Simply clone this repository and type the following command to install it::
Run & Convert
~~~~~~~~~~~~~

After install library, just run the script as below. Your `<file>.vcxproj` is of course required::
After install library, just run the script as below. Your ``.vcxproj`` file is of course required::

cmake-converter -p <path/to/file.vcxproj>`

Expand Down

0 comments on commit e8d6fdc

Please sign in to comment.