Add Fedora build instructions (#8)

* Add Fedora build instructions

* Update docs/BUILD-FEDORA.md

Co-authored-by: Kaito Udagawa <umireon@gmail.com>

* Update submodule URL in .gitmodules file

* Disable shadowing warnings in inja build

* Disable conversion errors on Linux

* Remove -Wshadow option from gcc compiler configuration

---------

Co-authored-by: Kaito Udagawa <umireon@gmail.com>

Author: royshil

.gitignore

@@ -17,6 +17,7 @@
 !README.md
 !/vendor
 !/vendor/inja
+!/docs
 
 # Exclude lock files
 *.lock.json

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "vendor/inja"]
 	path = vendor/inja
-	url = git@github.com:pantor/inja.git
+	url = https://github.com/pantor/inja.git

cmake/BuildInja.cmake

@@ -7,4 +7,11 @@ set(BUILD_BENCHMARK OFF)
 set(COVERALLS OFF)
 # inja uses a lot of shadowing
 add_compile_options(-Wno-shadow)
+add_compile_options(-Wno-error=shadow)
 add_subdirectory(${CMAKE_SOURCE_DIR}/vendor/inja ${CMAKE_BINARY_DIR}/inja EXCLUDE_FROM_ALL)
+
+# on linux, disable conversion errors
+if(UNIX AND NOT APPLE)
+  set(CMAKE_COMPILE_WARNING_AS_ERROR OFF)
+  add_compile_options(-Wno-error -Wno-conversion -Wno-shadow -Wno-unused-parameter)
+endif()

cmake/linux/compilerconfig.cmake

@@ -32,7 +32,6 @@ set(_obs_gcc_c_options
     -Wno-unused-function
     -Wno-unused-label
     -Wparentheses
-    -Wshadow
     -Wuninitialized
     -Wunreachable-code
     -Wunused-parameter

docs/BUILD-FEDORA.md

@@ -0,0 +1,29 @@
+## Instructions for building the plugin on Fedora
+
+First, you have to install the development tools:
+```
+sudo dnf groupinstall "Development Tools"
+```
+
+Then, make sure you have the dependencies of this plugin installed:
+
+```
+sudo dnf install cmake gcc-c++ ninja-build obs-studio-devel opencv-devel qt6-qtbase-devel zsh curl-devel tesseract-devel leptonica-devel
+```
+
+Clone the repository and set up the submodules:
+```
+git clone https://github.com/occ-ai/obs-ocr.git
+cd obs-ocr
+git submodule update --init
+```
+
+Run the following command to compile the plugin:
+```
+.github/scripts/build-linux --skip-deps
+```
+
+Finally, install the necessary files into the system directories, by issuing this command:
+```
+sudo cmake --install build_x86_64 --prefix /usr
+```