Skip to content

Commit

Permalink
Replace 'generate' command with 'sample-config'; update output
Browse files Browse the repository at this point in the history
  • Loading branch information
mdpiper committed Apr 10, 2024
1 parent c0ed06f commit 831408b
Showing 1 changed file with 50 additions and 31 deletions.
81 changes: 50 additions & 31 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,42 +156,61 @@ An example of a blank *babel.toml* file:

.. code:: toml
[library]
[library."<name>"]
language = "c"
library = ""
header = ""
entry_point = ""
[build]
undef_macros = []
define_macros = []
libraries = []
library_dirs = []
include_dirs = []
extra_compile_args = []
[package]
name = ""
requirements = []
# See https://babelizer.readthedocs.io/ for more information
[info]
github_username = "pymt-lab"
package_author = "csdms"
package_author_email = "csdms@colorado.edu"
package_license = "MIT"
summary = ""
[ci]
python_version = ["3.9"]
os = ["linux", "mac", "windows"]
You can generate *babel.toml* files using the *babelize generate* command.
# Describe the library being wrapped.
[library.Monorail]
language = "c"
library = "bmimonorail"
header = "monorail.h"
entry_point = "register_monorail"
# Describe compiler options to build the library being wrapped.
[build]
undef_macros = []
define_macros = []
libraries = []
library_dirs = []
include_dirs = []
extra_compile_args = []
# Describe the newly wrapped package.
[package]
name = "springfield_monorail"
requirements = ["three_million_dollars"]
# Provide author and package information.
[info]
github_username = "lyle-lanley"
package_author = "Lyle Lanley"
package_author_email = "lyle@monorail.com"
package_license = "MIT License"
summary = '''
Well, sir, there's nothing on Earth like a genuine,
bona fide, electrified, six-car monorail. What'd I say?
Monorail! What's it called? Monorail! That's right! Monorail!
'''
# Set continuous integration options.
[ci]
python_version = [
"3.10",
"3.11",
"3.12",
]
os = [
"linux",
"mac",
"windows",
]
You can generate *babelizer* configuration files using the ``babelize sample-config`` command.
For example, the above *babel.toml* was generated with:

.. code:: bash
babelize generate > babel.toml
babelize sample-config > babel.toml
Library section
^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 831408b

Please sign in to comment.