renamed stuff. updated readme

Nicholaswogan · Jan 27, 2022 · cd6ed49 · cd6ed49
1 parent a0038ee
commit cd6ed49
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 7 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,13 +1,13 @@
 
-cmake_minimum_required(VERSION 3.0)
-project (fortran-yaml-c LANGUAGES C Fortran)
+cmake_minimum_required(VERSION 3.4)
+project (FORTRAN_YAML_C VERSION 0.1.0 LANGUAGES C Fortran)
 
 include(FortranCInterface)
 FortranCInterface_VERIFY()
 
 add_subdirectory(libyaml EXCLUDE_FROM_ALL)
 
-add_library(fortran-yaml-c yaml_types.f90 yaml.f90 yaml.c)
+add_library(fortran-yaml-c yaml_types.f90 fortran_yaml_c.f90 libyaml_interface.c)
 target_link_libraries(fortran-yaml-c yaml)
 target_include_directories(fortran-yaml-c PUBLIC libyaml/include)
 

diff --git a/README.md b/README.md
@@ -1 +1,24 @@
 # fortran-yaml-c
+
+This is [YAML](http://yaml.org) parser for Fortran matching the YAML 1.1 spec.
+
+This package uses the C package [libyaml](https://github.com/yaml/libyaml) to parse yaml documents, then stores the data in Fortran derived types created by [fortran-yaml](https://github.com/BoldingBruggeman/fortran-yaml). Hence the name `fortran-yaml-c`.
+
+## Building
+
+First, clone this repository
+
+```
+git clone --recursive https://github.com/Nicholaswogan/fortran-yaml-c.git
+```
+
+Next, navigate to the root directory of `fortran-yaml-c`. Finally, run the following commands to build with `cmake` and run the test and example.
+
+```
+mkdir build
+cd build
+cmake ..
+cmake --build .
+./test_yaml
+./example
+```
diff --git a/example.f90 b/example.f90
@@ -1,7 +1,7 @@
 
 program example
   use, intrinsic :: iso_fortran_env, only:  output_unit
-  use yaml, only: parse, error_length
+  use fortran_yaml_c, only: parse, error_length
   use yaml_types, only: type_node, type_dictionary, type_error, real_kind, &
                         type_list, type_list_item, type_scalar
 

diff --git a/yaml.f90 → fortran_yaml_c.f90 b/yaml.f90 → fortran_yaml_c.f90
@@ -1,4 +1,4 @@
-module yaml
+module fortran_yaml_c
   use iso_c_binding
   use yaml_types
   implicit none
@@ -110,7 +110,8 @@ recursive subroutine read_value(node_c_ptr, node)
       ! is null
       allocate(type_null::node) 
     else
-      print*,'Problem!!!'
+      print*,"Something terrible broke in fortran-yaml-c. If this happens report a bug!"
+      stop 1
     endif
 
   end subroutine  

diff --git a/yaml.c → libyaml_interface.c b/yaml.c → libyaml_interface.c
diff --git a/test_yaml.f90 b/test_yaml.f90
@@ -1,7 +1,7 @@
 
 program test
   use, intrinsic :: iso_fortran_env, only:  output_unit
-  use yaml, only: parse, error_length
+  use fortran_yaml_c, only: parse, error_length
   use yaml_types, only: type_node
 
   class(type_node), pointer :: root